Skip to content

Conversation

@thomas-desmond
Copy link
Contributor

Summary

This PR includes a new example for Workflows. Referencing this example: https://github.com/cloudflare/docs-examples/tree/main/workflows/waitForEvent added to the doc-examples repository.

Documentation checklist

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 15, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Added a new example for Cloudflare Workflows demonstrating a human-in-the-loop image tagging process using the waitForEvent API.

  • Introduced a new example for Workflows that processes user-uploaded images with human approval.
  • Demonstrated the use of the waitForEvent API in a Cloudflare Workflow.
  • Included a Next.js frontend application for image upload and approval.
  • Provided detailed instructions and links to the complete codebase and deployment details.

Added Files

  • src/content/docs/workflows/examples/wait-for-event.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions github-actions bot added size/s product:workflows Workflows: https://developers.cloudflare.com/workflows/ labels Apr 15, 2025
:::note
The example on this page includes only a subset of the full implementation. For the complete codebase and deployment instructions, please refer to the [GitHub repository](https://github.com/cloudflare/docs-examples/tree/main/workflows/waitForEvent).
:::

Copy link
Contributor

@Oxyjun Oxyjun Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can deploy this example straight away using the "Deploy to Cloudflare" button.
[![Deploy to Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cloudflare/docs-examples/tree/main/workflows/waitForEvent)
Continue with the rest of the page to fully understand the example.

We could use the new button to expedite deployment, if the user wants that. I've not yet tested this code though.

@Oxyjun Oxyjun merged commit 4995a47 into cloudflare:production Apr 17, 2025
7 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Apr 17, 2025
@holopin-bot
Copy link

holopin-bot bot commented Apr 17, 2025

Congratulations @thomas-desmond, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm9lkzud983730cjgv2uqpzo8

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* Add Workflows example for Human-in-the-Loop Image Tagging with waitForEvent

* PCX Review

---------

Co-authored-by: Jun Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants